touchui-api

API

以小程序API方式调用h5+API

---

开发进度

开放接口

• 微信登陆
• 获取用户信息
• 发起支付

界面

暂不处理

设备

• 获取手机网络状态
• 获取手机系统信息
  • 异步获取手机系统信息
  • 同步获取手机系统信息
• 监听重力感应数据
• 监听罗盘数据
• 打电话
• 扫码

网络

• 发起一个请求
• WebSocket
• 上传文件
• 下载文件

媒体

• 图片
  • 选择图片
  • 预览图片
  • [x] 获取图片信息
  • 保存图片到系统相册
• 录音
  • 开始录音
  • 停止录音
  • 播放音频
  • 暂停播放音频
  • 停止播放音频
• 背景音频
  • 获取后台音乐播放状态
  • 使用后台播放器播放音乐
  • 暂停播放音乐
  • 控制音乐播放进度
  • 停止播放音乐
  • 监听音乐播放
  • 监听音乐暂停
  • 监听音乐停止
  • 获取全局唯一的背景音频管理器
• 文件
  • 保存文件到本地
  • 获取本地已保存的文件列表
  • 获取本地文件的文件信息
  • 删除本地存储的文件
  • 新开页面打开文档
• 视频
  • 拍摄视频或从手机相册中选视频
  • 保存视频到系统相册

位置

• 获取当前位置
• 使用原生地图查看位置
• 使用原生地图选择位置
• 地图组件控制

数据缓存

• storage

其他

剪贴板

• 设置系统剪贴板的内容
• 获取系统剪贴板内容

屏幕亮度

• 设置屏幕亮度
• 获取屏幕亮度
• 设置是否保持常亮状态

震动

• 使手机发生较长时间的振动
• 使手机发生较短时间的振动

手机联系人

• 添加联系人信息

截屏

• 监听截屏事件

蓝牙

• 蓝牙

拓展接口

• 将 ArrayBuffer 数据转成 Base64 字符串
• 将 ArrayBuffer 数据转成 Base64 字符串

使用文档

使用内置浏览器打开

api.openBrowser(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
url	String	是	要浏览的页面地址
backgroundColor	String	否	标题栏背景颜色
color	String	否	标题栏文字颜色
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

扫码

api.scanCode(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
onlyFromCamera	Boolean	否	是否只能从相机扫码，不允许从相册选择图片
backgroundColor	String	否	标题栏背景颜色
color	String	否	标题栏文字颜色
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

判断指纹硬件是否可用

api.canUseTouchID(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

使用指纹进行验证

api.useTouchID(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

分享到第三方应用

api.share(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
target	String	是	要分享到的应用（weixin_timeline、weixin_message、weibo、qq）
type	String	否	分享类型（link、text、image 默认为link）
title	String	否	分享标题（分享类型需为link）
content	String	否	分享内容(分享类型为text时必选)
icon	String	否	分享缩略图（分享类型需为link、图片大小需要小于30Kb）
href	String	否	分享链接（分享类型需为link）
pictures	Array	否	分享图片（分享类型需为image、图片地址不支持网络路径、部分平台仅支持分享一张图片）
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

选择联系人电话号码

api.pickPhoneNumber(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调，返回电话号码 phoneNumber
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

监听状态栏点击事件（仅支持iOS）

api.onStatusbarTap(CALLBACK)

CALLBACK返回参数：

无

监听返回按钮点击事件

api.onBackButtonClick(CALLBACK)

CALLBACK返回参数：

无

取消监听返回按钮点击

api.offBackButtonClick(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
listener	Function	是	要移除的事件监听回调函数
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

设置页面的侧滑关闭手势（仅支持iOS）

api.setPagePopGesture(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
openPagePopGesture	Boolean	是	是否开启侧滑关闭手势
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

设置系统状态栏样式（仅支持iOS和部分安卓）

api.setStatusBarStyle(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
style	String	是	系统状态栏样式（"dark"：深色前景色样式、"light"：浅色前景色样式）
success	Function	否	接口调用成功的回调
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

获取系统状态栏样式（仅支持iOS和部分安卓）

api.getStatusBarStyle(OBJECT)

OBJECT参数说明

参数	类型	必填	说明
success	Function	否	接口调用成功的回调，返回系统状态栏样式 style（"dark"：深色前景色样式、"light"：浅色前景色样式）
fail	Function	否	接口调用失败的回调函数
complete	Function	否	接口调用结束的回调函数（调用成功、失败都会执行）

进入全屏模式

api.enterFullscreen(CALLBACK)

CALLBACK返回参数：

无

离开全屏模式

api.leaveFullscreen(CALLBACK)

CALLBACK返回参数：

无

H5+ API初始化完毕

api.plusReady(CALLBACK)

CALLBACK返回参数：

无

判断是否APP环境

api.isApp

判断是否Android环境

api.isAndroid

判断是否Ios环境

api.isIos